home *** CD-ROM | disk | FTP | other *** search
/ PC World 2004 June / PCWorld_2004-06_cd.bin / software / vyzkuste / koolmoves / kmsetup.exe / {app} / Motion Scripts / My Scripts / flash 6 documentation.txt < prev    next >
Text File  |  2004-03-31  |  3KB  |  131 lines
  1. Flash 6 Effects Engine documentation file
  2. =========================================
  3.  
  4. Each effect consits of four functions:
  5. - main_init(mc)
  6. - main_effect(mc,frame)
  7. - sub_init(mc)
  8. - sub_effect(mc,frame)
  9.  
  10. When an effect is initialized, first the main_init function is executed, followed by sub_init for all subs. Every time an Enter Frame event occurs, sub_effect is executed for all active subs, followed by main_effect.  
  11.  
  12. The effect functions control the objects. The sub functions are used to apply an effect on each sub, the main functions to apply an effect on the main mc (the total of all subs).
  13.  
  14. The depth of the main mc (the total of all subs) is 5.
  15. The depths of the subs are 5, 15, 25, 35 etc. 
  16. Depths of 0, 10, 20, 30 etc. are used by the built in after image option.
  17. All other depths can be used to create duplicate mc's or masks required for an effect.
  18.  
  19. Most variable names are free to use. The ones that are not free to use are all variables starting with a $ and the special values listed below.
  20.  
  21.  
  22. glow_delay
  23. ==========
  24. ( After image delay )
  25. Number of frames the after image runs behind.
  26. Values below or equal to zero means no after image.
  27. If you are using the built in after image option and want to make a sub invisible, don't use the _visibility property but set _alpha to 0 instead.
  28.  
  29. glow_factor
  30. ===========
  31. ( After image transparency )
  32. Multiplication factor of the after image.
  33. For example 0.5 means the after image transparency is 50% of the original.
  34.  
  35. sub_delay
  36. =========
  37. Delay in frames between starting the subs. 
  38.  
  39. sub_order
  40. =========
  41. 0 = Normal flow
  42. 1 = Reverse flow
  43. 2 = Inner to outer
  44. 3 = Outer to inner
  45. 4 = Left to right
  46. 5 = Right to left
  47. 6 = Top to bottom
  48. 7 = Bottom to top
  49. 8 = Top left to bottom right
  50. 9 = Bottom right to top left
  51. 10 = Bottom left to top right
  52. 11 = Top right to bottom left
  53. 12 = Clockwise
  54. 13 = Counter clockwise
  55. 14 = Random
  56.  
  57. loop_delay
  58. ==========
  59. Delay in frames before looping the total effect.
  60. Values below zero indicate no loop.
  61.  
  62. subs_done
  63. =========
  64. Flag that is set by the engine when all subs have completed their sub_effect.
  65.  
  66. end_effect
  67. ==========
  68. Flag that needs to be set when the total effect is completed.
  69.  
  70. mc
  71. ==
  72. Reference to a movieclip.
  73.  
  74. mc.done
  75. =======
  76. Flag that needs to be set when a sub has completed it's sub_effect.
  77.  
  78. mc._i
  79. =====
  80. Number assigned to each sub starting with 0 for the sub with the lowest depth.
  81. ( for example if mc._i = 4, the depth of the sub is 45 )
  82.  
  83. mc.__x
  84. ======
  85. Used to store initital _x value.
  86.  
  87. mc.__y
  88. ======
  89. Used to store the initial _y value.
  90.  
  91. frame
  92. =====
  93. Current frame inside an effect.
  94.  
  95. deg0 - deg360 (in steps of 15 degrees)
  96. ======================================
  97. Pre defined rad conversions.
  98. For example Math.sin(deg60)
  99.  
  100. $padding
  101. ========
  102. The amount of padding that is added by KM to the width and height of a sub.
  103. For example a value of 8 indicates 8 pixels to the width and 8 pixels to the
  104. height or in other words 4 pixels padding on all sides.
  105.  
  106. $sub_cnt
  107. ========
  108. Internal variable indicating the amount of subs.
  109.  
  110. $i (only in sub_effect)
  111. =======================
  112. Sequence number of the current sub.
  113.  
  114. $smc
  115. ====
  116. Array containing references to all sub mc's.
  117.  
  118. $mmc
  119. ====
  120. Reference to the main mc.
  121.  
  122. onEnd
  123. =====
  124. Function that is called when the total effect ends.
  125. This function is only called when looping is off.
  126.  
  127. onLoop
  128. ======
  129. Function that is called when looping.
  130.  
  131.